[CHORE] Upgrade MDX to v3#361
Open
John McCall (lowlydba) wants to merge 5 commits intomainfrom
Open
Conversation
Replace HTML-style comments (<!-- ... -->) with MDX/JSX comment syntax ({/* ... */}) across many blog and docs MDX files to ensure comments are handled correctly by the MDX/React parser. Also update docusaurus.config.js mdx1Compat settings to disable legacy comments and admonitions (comments: false, admonitions: false) to align with the MDX comment changes and avoid compatibility issues.
Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
Signed-off-by: John McCall <john@overturemaps.org>
John McCall (lowlydba)
temporarily deployed
to
check-linked-issue-app
GitHub Actions
Inactive
John McCall (lowlydba)
temporarily deployed
to
staging
GitHub Actions
Inactive
Super-linter summary
Super-linter detected linting errors For more information, see the GitHub Actions workflow run Powered by Super-linter MARKDOWN |
🗺️ OMF Docs previews are live!
Auto-gen schema site is now available. This is an early preview of a future workflow where we will automatically generate and publish reference docs for the Overture Maps Format schema with every change to the schema repo. Note ♻️ This preview updates automatically with each push to this PR. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Docusaurus site content/config to be compatible with MDX v3 by removing MDX1 compatibility settings and migrating legacy HTML comment usage in MD/MDX content.
Changes:
- Removed
mdx1Compatsettings from the Docusaurus config. - Replaced
<!-- truncate -->(and variants) with JSX comment markers in blog posts. - Replaced other HTML comment blocks inside MDX docs with JSX comments.
Reviewed changes
Copilot reviewed 46 out of 46 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docusaurus.config.js | Removes MDX1 compatibility configuration in preparation for MDX v3. |
| docs/schema/index.md | Updates a heading line during MDX v3 migration (note: current change alters anchor behavior). |
| docs/examples/build-a-map.mdx | Converts inline section-label HTML comments inside tabs to JSX comments. |
| docs/examples/athena-aws.mdx | Converts a large commented-out optional section from HTML comment syntax to JSX comment syntax. |
| blog/2026-04-15-release-notes.mdx | Converts blog truncate marker to JSX comment. |
| blog/2026-03-18-release-notes.mdx | Converts blog truncate marker to JSX comment. |
| blog/2026-03-12-explorer-got-pretty.mdx | Converts blog truncate marker to JSX comment. |
| blog/2026-02-18-release-notes.mdx | Converts blog truncate marker to JSX comment. |
| blog/2026-02-11-stac.mdx | Converts blog truncate marker to JSX comment. |
| blog/2026-01-21-release-notes.mdx | Converts blog truncate marker to JSX comment. |
| blog/2025-12-17-release-notes.mdx | Converts blog truncate marker to JSX comment. |
| blog/2025-11-19-release-notes.mdx | Converts blog truncate marker to JSX comment. |
| blog/2025-10-22-release-notes.mdx | Converts blog truncate marker to JSX comment. |
| blog/2025-09-24-release-notes.mdx | Converts blog truncate marker to JSX comment. |
| blog/2025-08-20-release-notes.mdx | Converts blog truncate marker to JSX comment. |
| blog/2025-07-23-release-notes.mdx | Converts blog truncate marker to JSX comment. |
| blog/2025-06-25-release-notes.mdx | Converts blog truncate marker to JSX comment. |
| blog/2025-06-25-getting-started-gers.mdx | Converts blog truncate marker to JSX comment. |
| blog/2025-05-21-release-notes.mdx | Converts blog truncate marker to JSX comment. |
| blog/2025-04-23-release-notes.mdx | Converts blog truncate marker to JSX comment. |
| blog/2025-03-19-release-notes.mdx | Converts blog truncate marker to JSX comment. |
| blog/2025-02-19-release-notes.mdx | Converts blog truncate marker to JSX comment. |
| blog/2025-01-22-release-notes.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024/2024-12-18.0.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024/2024-11-13.0.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024/2024-10-23.0.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024/2024-09-18.0.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024/2024-08-20.0.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024/2024-07-22.0.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024-beta/2024-06-13-beta.0.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024-beta/2024-05-16-beta.0.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024-beta/2024-04-16-beta.0.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024-alpha/2024-03-12-alpha.0.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024-alpha/2024-02-15-alpha.0.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024-alpha/2024-01-17-alpha.0.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024-12-18-transportation-to-ga.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024-10-21-preview-october-release.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024-08-15-preview-august-release.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024-07-24-explore-site.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024-05-16-land-cover.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024-04-22-beta-release.mdx | Converts blog truncate marker to JSX comment. |
| blog/2024-04-21-welcome.mdx | Converts blog truncate marker to JSX comment. |
| blog/2023-alpha/2023-12-14-alpha.0.mdx | Converts blog truncate marker to JSX comment. |
| blog/2023-alpha/2023-11-14-alpha.0.mdx | Converts blog truncate marker to JSX comment. |
| blog/2023-alpha/2023-10-19-alpha.0.mdx | Converts blog truncate marker to JSX comment. |
| blog/2023-alpha/2023-07-26-alpha.0.mdx | Converts blog truncate marker to JSX comment. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: John McCall <john@overturemaps.org>
Update references to the schema docs and clean up the schema index heading. The blog post now links to the canonical /schema/ page instead of the old /schema/reference/#top-level-properties anchor, and docs/schema/index.md removes an inline anchor/comment from the H1 to simplify the heading text. Signed-off-by: John McCall <john@overturemaps.org>
John McCall (lowlydba)
temporarily deployed
to
check-linked-issue-app
GitHub Actions
Inactive
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Connie Sun (connieksun)
approved these changes
Apr 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request
This pull request updates all blog post markdown files to replace the old HTML comment
<!-- truncate -->(and variants like<!--truncate-->) with the JSX comment syntax{/* truncate */}. This change ensures consistency and compatibility with MDX, which supports JSX-style comments instead of HTML comments.The most important changes are:
Migration to JSX comment syntax in blog posts:
<!-- truncate -->and<!--truncate-->with{/* truncate */}in blog post.mdxfiles to conform to MDX/JSX standards. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20]This is a straightforward, non-functional change that improves code consistency and prevents potential rendering issues in the documentation site.